Improve clarity of error description in README#49
Merged
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the README to better explain how this project surfaces Roslyn Source Generator errors in the IDE, aiming to make the value proposition clearer for users evaluating the package.
Changes:
- Rewrote the “Verbose and easy to understand errors” paragraph for clearer wording and more concrete description of the IDE experience.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| Remove the guesswork from Source Generators mistakes. | ||
|
|
||
| Roslyn Source Generator projects often produce errors that are hard to understand. One of the main goals for this package is to make sure all errors, including user errors, setup errors, and edgecases are verbose and easily visible as an error line in your IDE. | ||
| Roslyn Source Generator projects often produce errors that are hard to understand. One of the main goals of this package is to make sure that any error - whether it’s a user mistake, a setup problem, or an edge case - shows up clearly in your IDE by highlighting the line that caused it. |
There was a problem hiding this comment.
This sentence uses a typographic apostrophe (’ in “it’s”), which is the only occurrence in the README. Consider switching to a plain ASCII apostrophe (') to keep punctuation consistent and avoid potential copy/paste/encoding issues in some environments.
Suggested change
| Roslyn Source Generator projects often produce errors that are hard to understand. One of the main goals of this package is to make sure that any error - whether it’s a user mistake, a setup problem, or an edge case - shows up clearly in your IDE by highlighting the line that caused it. | |
| Roslyn Source Generator projects often produce errors that are hard to understand. One of the main goals of this package is to make sure that any error - whether it's a user mistake, a setup problem, or an edge case - shows up clearly in your IDE by highlighting the line that caused it. |
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.